<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta content="Cask Data, Inc." name="author" />
<meta content="Copyright © 2015-2017 Cask Data, Inc." name="copyright" />


    <meta name="git_release" content="6.1.1">
    <meta name="git_hash" content="05fbac36f9f7aadeb44f5728cea35136dbc243e5">
    <meta name="git_timestamp" content="2020-02-09 08:22:47 +0800">
    <title>Supported Characters</title>

    <link rel="stylesheet" href="_static/cdap-bootstrap.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" />
    <link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" type="text/css" />
    <link rel="stylesheet" href="_static/css/bootstrap-sphinx.css" type="text/css" />
    <link rel="stylesheet" href="_static/css/cdap-dynamicscrollspy-4.css" type="text/css" />
    <link rel="stylesheet" href="_static/css/jquery.mCustomScrollbar.css" type="text/css" />
    <link rel="stylesheet" href="_static/css/cdap-jquery.mCustomScrollbar.css" type="text/css" />
    <link rel="stylesheet" href="_static/css/abixTreeList-2.css" type="text/css" />
    <link rel="stylesheet" href="_static/cdap-bootstrap.css" type="text/css" />

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '6.1.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  false
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>

    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Cask Data Application Platform 6.1.1 Documentation" href="index.html" />
    <link rel="next" title="Command Line Interface API" href="cli-api.html" />
    <link rel="prev" title="CDAP 参考手册: APIs, Licenses, and Dependencies" href="index.html" />
    <!-- block extrahead -->
    <meta charset='utf-8'>
    <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
    <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
    <meta name="apple-mobile-web-app-capable" content="yes">
    <!-- block extrahead end -->

</head>
<body role="document">

<!-- block navbar -->
<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
    <div class="container-fluid">
      <div class="row">
        <div class="navbar-header">
          <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
          <a class="navbar-brand" href="table-of-contents/../../index.html">
            <span><img alt="CDAP logo" src="_static/cdap_logo.svg"/></span>
          </a>

          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>

          <div class="pull-right">
            <div class="dropdown version-dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown"
                role="button" aria-haspopup="true" aria-expanded="false">
                v 6.1.1 <span class="caret"></span>
              </a>
              <ul class="dropdown-menu">
                <li><a href="//docs.cdap.io/cdap/5.1.2/en/index.html">v 5.1.2</a></li>
                <li><a href="//docs.cdap.io/cdap/4.3.4/en/index.html">v 4.3.4</a></li>
              </ul>
            </div>
          </div>
          <form class="navbar-form navbar-right navbar-search" action="search.html" method="get">
            <div class="form-group">
              <div class="navbar-search-image material-icons"></div>
              <input type="text" name="q" class="form-control" placeholder="  Search" />
            </div>
            <input type="hidden" name="check_keywords" value="yes" />
            <input type="hidden" name="area" value="default" />
          </form>

          <div class="collapse navbar-collapse nav-collapse navbar-right navbar-navigation">
            <ul class="nav navbar-nav"><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="table-of-contents/../../index.html">简介</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="table-of-contents/../../guides.html">手册</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link current" href="table-of-contents/../../reference-manual/index.html">参考</a></li><li class="docsite-nav-tab-container"><a class="docsite-nav-tab-link " href="table-of-contents/../../faqs/index.html">帮助</a></li>
            </ul>
          </div>

        </div>
      </div>
    </div>
  </div><!-- block navbar end -->
<!-- block main content -->
<div class="main-container container">
  <div class="row"><div class="col-md-2">
      <div id="sidebar" class="bs-sidenav scrollable-y-outside" role="complementary">
<!-- theme_manual: reference-manual -->
<!-- theme_manual_highlight: reference -->
<!-- sidebar_title_link: Reference -->

  <div role="note" aria-label="manuals links"><h3>Reference</h3>
    <ul class="reference-page-menu">
      <nav class="pagenav">
      <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html"> Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"> Supported Characters</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli-api.html"> Command Line Interface API</a></li>
<li class="toctree-l1"><a class="reference internal" href="http-restful-api/index.html"> HTTP RESTful API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/artifact.html">Artifact</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/configuration.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/dataset.html">Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/lifecycle.html">Lifecycle</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/logging.html">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/metadata.html">Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/monitor.html">Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/namespace.html">Namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/dashboard.html">Dashboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/preferences.html">Preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/profile.html">Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/query.html">Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/reports.html">Reports</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/service.html">Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="http-restful-api/workflow.html">Workflow</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="java-client-api.html"> Java Client API</a></li>
<li class="toctree-l1"><a class="reference internal" href="javadocs/index.html"> Javadocs</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html"> 发行说明</a></li>
<li class="toctree-l1"><a class="reference internal" href="licenses/index.html"> Trademarks, Licenses, and Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html"> 术语表</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html"> Index</a></li>
</ul>
</nav>
    </ul>
  </div></div>
    </div><div class="col-md-8 content" id="main-content">
    
  <div class="section" id="supported-characters">
<span id="id1"></span><h1>Supported Characters<a class="headerlink" href="#supported-characters" title="Permalink to this headline">🔗</a></h1>
<p>The Cask Data Application Platform (CDAP) has different naming conventions for different entities in CDAP.
We distinguish these different character sets, and note which entities use them:</p>
<div class="section" id="alphanumeric-character-set">
<span id="supported-characters-alphanumeric-character-set"></span><h2>Alphanumeric Character Set<a class="headerlink" href="#alphanumeric-character-set" title="Permalink to this headline">🔗</a></h2>
<p>This is the basic character set that all entities support:</p>
<ul class="simple">
<li>Alphanumeric characters (<code class="docutils literal notranslate"><span class="pre">a-z</span> <span class="pre">A-Z</span> <span class="pre">0-9</span></code>)</li>
</ul>
</div>
<div class="section" id="alphanumeric-extended-character-set">
<span id="supported-characters-alphanumeric-extended-character-set"></span><h2>Alphanumeric Extended Character Set<a class="headerlink" href="#alphanumeric-extended-character-set" title="Permalink to this headline">🔗</a></h2>
<p><strong>Namespace IDs</strong> can use an <em>alphanumeric extended character set:</em></p>
<ul class="simple">
<li>Alphanumeric characters (<code class="docutils literal notranslate"><span class="pre">a-z</span> <span class="pre">A-Z</span> <span class="pre">0-9</span></code>)</li>
<li>Underscores (<code class="docutils literal notranslate"><span class="pre">_</span></code>)</li>
</ul>
</div>
<div class="section" id="alphanumeric-extra-extended-character-set">
<span id="supported-characters-alphanumeric-extra-extended-character-set"></span><h2>Alphanumeric Extra Extended Character Set<a class="headerlink" href="#alphanumeric-extra-extended-character-set" title="Permalink to this headline">🔗</a></h2>
<p>Except as noted on this page, <strong>all other CDAP entities</strong> (such as streams, datasets, flows, apps,
plugins) support an <em>alphanumeric extra extended character set:</em></p>
<ul class="simple">
<li>Alphanumeric characters (<code class="docutils literal notranslate"><span class="pre">a-z</span> <span class="pre">A-Z</span> <span class="pre">0-9</span></code>)</li>
<li>Hyphens (<code class="docutils literal notranslate"><span class="pre">-</span></code>)</li>
<li>Underscores (<code class="docutils literal notranslate"><span class="pre">_</span></code>)</li>
</ul>
<p>Note that streams and datasets whose names begin with an underscore (<code class="docutils literal notranslate"><span class="pre">_</span></code>) will not be
visible in the home page of the <a class="reference external" href="../../admin-manual/operations/cdap-ui.html#cdap-ui" title="(in Cask Data Application Platform v6.1.1)"><span class="xref std std-ref">CDAP UI</span></a>, though they will be visible
elsewhere in the CDAP UI.</p>
</div>
<div class="section" id="dataset-character-set-deprecated">
<h2>Dataset Character Set (Deprecated)<a class="headerlink" href="#dataset-character-set-deprecated" title="Permalink to this headline">🔗</a></h2>
<p>In earlier versions of CDAP, <strong>Dataset names</strong> used the alphanumeric extra extended character set, plus periods:</p>
<ul class="simple">
<li>Alphanumeric characters (<code class="docutils literal notranslate"><span class="pre">a-z</span> <span class="pre">A-Z</span> <span class="pre">0-9</span></code>)</li>
<li>Hyphens (<code class="docutils literal notranslate"><span class="pre">-</span></code>)</li>
<li>Periods (<code class="docutils literal notranslate"><span class="pre">.</span></code>)</li>
<li>Underscores (<code class="docutils literal notranslate"><span class="pre">_</span></code>)</li>
</ul>
<p>We recommend that instead you use the <em>Alphanumeric Extra Extended Character Set</em>, as support for this may
be removed in the future.</p>
</div>
<div class="section" id="hive-limitation-and-conversion">
<h2>Hive Limitation and Conversion<a class="headerlink" href="#hive-limitation-and-conversion" title="Permalink to this headline">🔗</a></h2>
<p><a class="reference external" href="https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-CreateTable">Hive 0.12</a>
only supports the <em>alphanumeric extended character set:</em> alphanumeric characters (<code class="docutils literal notranslate"><span class="pre">a-z</span>
<span class="pre">A-Z</span> <span class="pre">0-9</span></code>) and underscores (<code class="docutils literal notranslate"><span class="pre">_</span></code>).</p>
<p>As a consequence, any hyphens in stream names and any hyphens or periods in dataset names
will be converted to underscores while creating Hive tables.</p>
<p>Examples:</p>
<ul>
<li><p class="first">The streams</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">my-ingest</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">my_ingest</span></code></li>
</ul>
</div></blockquote>
<p>will both be converted to <code class="docutils literal notranslate"><span class="pre">stream_my_ingest</span></code></p>
</li>
<li><p class="first">The datasets</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">my-dataset</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">my_dataset</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">my.dataset</span></code></li>
</ul>
</div></blockquote>
<p>will all be converted to <code class="docutils literal notranslate"><span class="pre">dataset_my_dataset</span></code></p>
</li>
</ul>
<p>Names should be carefully constructed to avoid any collisions as a result of conversion.</p>
<p>Note that if you configure the Hive table name using the <code class="docutils literal notranslate"><span class="pre">explore.table.name</span></code> property
(see <a class="reference external" href="../../developer-manual/data-exploration/index.html#data-exploration" title="(in Cask Data Application Platform v6.1.1)"><span class="xref std std-ref">Data Exploration</span></a>), then the value of that property is
used literally; that is, no prefix is added and no character conversion takes place.</p>
</div>
</div>

</div>
    <div class="col-md-2">
      <div id="right-sidebar" class="bs-sidenav scrollable-y" role="complementary">
        <div id="localtoc-scrollspy">
        </div>
      </div>
    </div></div>
</div>
<!-- block main content end -->
<!-- block footer -->
<footer class="footer">
      <div class="container">
        <div class="row">
          <div class="col-md-2 footer-left"><a title="CDAP 参考手册: APIs, Licenses, and Dependencies" href="index.html" />Previous</a></div>
          <div class="col-md-8 footer-center"><a class="footer-tab-link" href="table-of-contents/../../reference-manual/licenses/index.html">Copyright</a> &copy; 2014-2020 Cask Data, Inc.&bull; <a class="footer-tab-link" href="//docs.cask.co/cdap/6.1.1/cdap-docs-6.1.1-web.zip" rel="nofollow">Download</a> an archive or
<a class="footer-tab-link" href="//docs.cask.co/cdap">switch the version</a> of the documentation
          </div>
          <div class="col-md-2 footer-right"><a title="Command Line Interface API" href="cli-api.html" />Next</a></div>
        </div>
      </div>
    </footer>
<!-- block footer end -->
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script><script type="text/javascript" src="_static/js/bootstrap-sphinx.js"></script><script type="text/javascript" src="_static/js/abixTreeList-2.js"></script><script type="text/javascript" src="_static/js/cdap-dynamicscrollspy-4.js"></script><script type="text/javascript" src="_static/js/cdap-version-menu.js"></script><script type="text/javascript" src="_static/js/copy-to-clipboard.js"></script><script type="text/javascript" src="_static/js/jquery.mousewheel.min.js"></script><script type="text/javascript" src="_static/js/jquery.mCustomScrollbar.js"></script><script type="text/javascript" src="_static/js/js.cookie.js"></script><script type="text/javascript" src="_static/js/tabbed-parsed-literal-0.2.js"></script><script type="text/javascript" src="_static/js/cdap-onload-javascript.js"></script><script type="text/javascript" src="_static/js/cdap-version-menu.js"></script>
    <script src="https://cdap.gitee.io/docs/cdap/json-versions.js"/></script>
  </body>
</html>